home *** CD-ROM | disk | FTP | other *** search
/ PD ROM 1 / PD ROM Volume I - Macintosh Software from BMUG (1988).iso / Programming / Complete Applications / unix.sed.c.src / SED.MAN < prev    next >
Encoding:
Text File  |  1987-07-01  |  9.4 KB  |  249 lines  |  [TEXT/ttxt]
  1. NAME
  2.    sed - the stream editor
  3.  
  4.  
  5. SYNOPSIS
  6.    sed [-n] [-g] [-e script ] [-f sfile ] [ file ] ...
  7.  
  8.  
  9. DESCRIPTION
  10.    Sed copies the named files (standard input default) to the standard
  11. output, edited according to a script of commands. 
  12.    An -e option supplies a single edit command from the next argument;
  13. if there are several of these they are executed in the order in  which
  14. they appear. If there is just one -e option and no -f 's, the -e  flag
  15. may be omitted.
  16.    An -f option causes commands to be taken from the file "sfile";  if
  17. there are several  of these they are  executed in the order  in  which
  18. they appear; -e and -f commands may be mixed.
  19.    The -g option causes sed to act as though every substitute  command
  20. in the script has a g suffix.
  21.    The -n option suppresses the default output.
  22.  
  23.    A script consists of commands, one per line, of the following form:
  24.  
  25. [address [, address] ] function [arguments]
  26.  
  27.    Normally sed cyclically copies a line of input into a  current text
  28. buffer, then applies all commands whose addresses select the buffer in
  29. sequence, then copies the buffer to standard output and clears it.
  30.    The -n option suppresses normal output (so that only p and w output
  31. is done). Also, some commands (n, N) do their own line reads, and some
  32. others (d, D) cause all commands following in the script to be skipped
  33. (the D command also suppresses the clearing of the current text buffer
  34. that would normally occur before the next cycle).
  35.  
  36.    It is also helpful to know that there's a second buffer (called the
  37. 'hold space' that can be copied or appended to or from or swapped with
  38. the current text buffer.
  39.  
  40.    An address is: a decimal numeral (which matches the line it numbers
  41. where line numbers start at 1 and run cumulatively across files), or a
  42. `$' that addresses the last line of input, or a context address, which
  43. is a `/regular expression/', in the style of ed (1) modified thus:
  44.  
  45. (1) The escape sequence `\n'  matches a newline embedded in the buffer,
  46.     and `\t' matches a tab.
  47.  
  48. (2) A command line with no addresses selects every buffer.
  49.  
  50. (3) A command line with one address selects every buffer that  matches
  51.     that address.
  52.  
  53. (4) A command line with two addresses selects the inclusive range from
  54.     the first input buffer  that matches the first address through the
  55.     next input buffer  that matches the second. (If the second address
  56.     is a number less than or equal to the line number first  selected,
  57.     only one line is selected.) Once the second address is matched sed
  58.     starts looking for the first one again; thus,  any number of these 
  59.     ranges will be matched.
  60.  
  61.    The negation operator '!' can prefix a command to apply it to every
  62. line not selected by the address(es).
  63.  
  64.    In the following list of functions, the maximum number of addresses
  65. permitted for each function is indicated in parentheses.
  66.    An argument denoted "text" consists of one or more lines,  with all
  67. but the last ending with `\' to hide the newline.
  68.    Backslashes in text are treated like backslashes in the replacement
  69. string of an `s' command and may be used to protect initial whitespace
  70. (blanks and tabs) against the stripping that is done on every line  of
  71. the script.
  72.  
  73.    An argument denoted "rfile" or "wfile"  must be last on the command
  74. line. Each wfile is created before processing begins.  There can be at
  75. most 10 distinct wfile arguments.
  76.  
  77. a "text"   (1)
  78.    Append. Place text on output before reading the next input line.
  79.  
  80. b "label"  (2)
  81.    Branch to the `:' command bearing the label.  If no label is  given,
  82. branch to the end of the script.
  83.  
  84. c "text"   (2)
  85.    Change. Delete the current text buffer.  With 0 or 1 address,  or at
  86. the end of a 2-address range, place text on the output.  Start the next
  87. cycle.
  88.  
  89. d          (2)
  90.    Delete the current text buffer. Start the next cycle.
  91.  
  92. D          (2)
  93.    Delete the first line of the current text buffer (all chars up to the
  94. first newline). Start the next cycle.
  95.  
  96. g          (2)
  97.    Replace the contents of the current text buffer with the contents  of
  98. the hold space.
  99.  
  100. G          (2)
  101.    Append the contents of the hold space to the current text buffer.
  102.  
  103. h          (2)
  104.    Copy the current text buffer into the hold space.
  105.  
  106. H          (2)
  107.    Append a copy of the current text buffer to the hold space.
  108.  
  109. i "text"   (1)
  110.    Insert. Place text on the standard output.
  111.  
  112. l          (2)
  113.    List. Sends the pattern space to standard output.  A "w" option may
  114. follow as in the s command below. Non-printable characters expand to:
  115.    \b  --  backspace (ASCII 08)
  116.    \t  --  tab       (ASCII 09)
  117.    \n  --  newline   (ASCII 10)
  118.    \r  --  return    (ASCII 13)
  119.    \e  --  escape    (ASCII 27)
  120.    \xx --  the ASCII character corresponding to 2 hex digits xx.
  121.  
  122. n          (2)
  123.    Copy the current text buffer to standard output. Read the next line
  124. of input into it.
  125.  
  126. N          (2)
  127.    Append the next line of input to the current text buffer, inserting
  128. an embedded newline between the two. The current line number changes.
  129.  
  130. p          (2)
  131.    Print. Copy the current text buffer to the standard output.
  132.  
  133. P          (2)
  134.    Copy the first line of the current text buffer (all chars up to the
  135. first newline) to standard output.
  136.  
  137. q          (1)
  138.    Quit. Branch to the end of the script. Do not start a new cycle.
  139.  
  140. r "rfile"  (1)
  141.    Read the contents of rfile. Place them on the output before reading
  142. the next input line.
  143.  
  144. s /regular expression/replacement/flags         (2)
  145.    Substitute the replacement for instances of the regular  expression
  146. in the current text buffer.  Any character may be used instead of `/'.
  147. For a fuller description see ed (1).
  148.    Flags is zero or more of the following:
  149.  
  150. g -- Global. Substitute for all nonoverlapping instances of the string
  151.      rather than just thefirst one.
  152.  
  153. p -- Print the pattern space if a replacement was made.
  154.  
  155. w -- Write. Append the current text buffer to a file argument as in  a
  156.      w command if a replacement is made. Standard output is used if no
  157.      file argument is given
  158.  
  159. t "label"  (2)
  160.    Branch-if-test. Branch to the : command with the given label if any
  161. substitutes have been made since the most recent read of an input line
  162. or execution of a `t'or `T'.  If no label is given,  branch to the end
  163. of the script.
  164.  
  165. T "label"  (2)
  166.    Branch-on-error. Branch to the : command with the given label if  no
  167. substitutes have succeeded since the last input line or t or T command.
  168. Branch to the end of the script if no label is given.
  169.  
  170. w "wfile"  (2)
  171.    Write. Append the current text buffer to wfile .
  172.  
  173. W "wfile"  (2)
  174.    Write first line.  Append first line  of the current text buffer
  175. to wfile.
  176.  
  177. x          (2)
  178.    Exchange the contents of the current text buffer and hold space.
  179.  
  180. y /string1/string2/      (2)
  181.    Translate. Replace each occurrence of a character  in string1  with
  182. the corresponding character in string2.  The lengths of  these strings
  183. must be equal.
  184.  
  185. ! "command"              (2)
  186.    All-but.  Apply the function (or group, if function is `{') only to
  187. lines not selected by the address(es).
  188.  
  189. : "label"  (0)
  190.    This command does nothing but hold a label for `b' and `t' commands
  191. to branch to.
  192.  
  193. =          (1)
  194.    Place the current line number on the standard output as a line.
  195.  
  196. {          (2)
  197.    Execute the following commands through a matching `}' only when the
  198. current line matches the address or address range given.
  199.  
  200.    An empty command is ignored.
  201.  
  202.  
  203. PORTABILITY
  204.    This tool was reverse-engineered from BSD 4.1 UNIX sed, and (as far
  205. as the author's knowledge and tests can determine) is compatible  with
  206. it. All documented features of BSD 4.1 sed are supported.
  207.  
  208.    One undocumented feature (a leading 'n' in the first comment having
  209. the same effect as an  -n command-line option)  has been omitted.
  210.  
  211. The following bugs and limitations have been fixed:
  212.    * There is no hidden length limit (40 in BSD sed) on w file names.
  213.    * There is no limit (8 in BSD sed) on the length of labels.
  214.    * The exchange command now works for long pattern and hold spaces.
  215.  
  216. The following enhancements to existing commands have been made:
  217.    * a, i commands don't insist on a leading backslash-\n in the text.
  218.    * r, w commands don't insist on whitespace before the filename.
  219.    * The g, p and P options on s commands may be given in any order.
  220.  
  221. Some enhancements to regular-expression syntax have been made:
  222.    * \t is recognized in REs (and elswhere) as an escape for tab.
  223.    * In an RE, + calls for 1..n repeats of the previous pattern.
  224.  
  225. The following are completely new features:
  226.    * The l command (list, undocumented and weaker in BSD)
  227.    * The W command (write first line of pattern space to file).
  228.    * The T command (branch on last substitute failed).
  229.    * Trailing comments are now allowed on command lines.
  230.  
  231.    In addition,  sed's error messages have been made more specific and
  232. informative.
  233.  
  234.    The implementation is also  significantly  smaller and  faster than 
  235. BSD 4.1 sed. It uses only the standard I/O library and exit.
  236.  
  237.  
  238. NOTE
  239.    This is a freeware component of the GNU  operating system. The user
  240. is hereby granted permission to use, modify, reproduce and  distribute
  241. it subject to the following conditions:
  242.    1. The authorship notice appearing  in  each source file may not be
  243. altered or deleted.
  244.    2. The object form may not be distributed without source.
  245.  
  246.  
  247. SEE ALSO
  248.    ed(1), grep(1), awk(1), lex(1), regexp(5)
  249.